sourceview.Tag source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module sourceview.Tag;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import gtk.TextTag;
31 private import sourceview.c.functions;
32 public  import sourceview.c.types;
33 
34 
35 /**
36  * A tag that can be applied to text in a [class@Buffer].
37  * 
38  * `GtkSourceTag` is a subclass of [class@Gtk.TextTag] that adds properties useful for
39  * the GtkSourceView library.
40  * 
41  * If, for a certain tag, [class@Gtk.TextTag] is sufficient, it's better that you create
42  * a [class@Gtk.TextTag], not a [class@Tag].
43  */
44 public class Tag : TextTag
45 {
46 	/** the main Gtk struct */
47 	protected GtkSourceTag* gtkSourceTag;
48 
49 	/** Get the main Gtk struct */
50 	public GtkSourceTag* getTagStruct(bool transferOwnership = false)
51 	{
52 		if (transferOwnership)
53 			ownedRef = false;
54 		return gtkSourceTag;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)gtkSourceTag;
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (GtkSourceTag* gtkSourceTag, bool ownedRef = false)
67 	{
68 		this.gtkSourceTag = gtkSourceTag;
69 		super(cast(GtkTextTag*)gtkSourceTag, ownedRef);
70 	}
71 
72 
73 	/** */
74 	public static GType getType()
75 	{
76 		return gtk_source_tag_get_type();
77 	}
78 
79 	/**
80 	 * Creates a `GtkSourceTag`.
81 	 *
82 	 * Configure the tag using object arguments, i.e. using [method@GObject.Object.set].
83 	 *
84 	 * For usual cases, [method@Buffer.create_source_tag] is more convenient to
85 	 * use.
86 	 *
87 	 * Params:
88 	 *     name = tag name, or %NULL.
89 	 *
90 	 * Returns: a new `GtkSourceTag`.
91 	 *
92 	 * Throws: ConstructionException GTK+ fails to create the object.
93 	 */
94 	public this(string name)
95 	{
96 		auto __p = gtk_source_tag_new(Str.toStringz(name));
97 
98 		if(__p is null)
99 		{
100 			throw new ConstructionException("null returned by new");
101 		}
102 
103 		this(cast(GtkSourceTag*) __p, true);
104 	}
105 }